minimal fix for issue 97 #99
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
half-shell
reviewed
Feb 5, 2024
Comment on lines
+1
to
+4
| defmodule Issue97Test do | ||
| use ExUnit.Case | ||
|
|
||
| test "stream_tags doesn't hang when used with stream take on empty xml" do |
There was a problem hiding this comment.
Suggested change
| defmodule Issue97Test do | |
| use ExUnit.Case | |
| test "stream_tags doesn't hang when used with stream take on empty xml" do | |
| defmodule SweetXmlTest do | |
| use ExUnit.Case | |
| describe "stream_tags/3" do | |
| # c.f. https://github.com/kbrw/sweet_xml/issues/97 | |
| test "should not hang when used with Stream.take/2 on an empty xml" do |
💅
While I do like the fact that this helps linking these tests to the issue raised to gain an understanding of the reason it was added, i think having a meaningful test module name might be better for overall comprehension and reading of test files.
Especially considering there are several ways of achieving the same results through other means; for instance, the commit itself already have that information. We could even put a link to the Github issue in the commit description, and / or even in a @doc or @docmodule attribute here.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I think there is a more fundamental improvement that can be done to fix this issue by reviewing how we use
Stream.resource, but this is the smallest change we can do to improve the situation right nowcf #97